Interface SimulationPanel

All Superinterfaces:
IPCObject
All Known Implementing Classes:
SimulationPanelImpl

public interface SimulationPanel extends IPCObject
Information provided by the PKI file:

    \class SimulationPanel
    
    \brief SimulationPanel allows for UI manipulation of the Simulation Panel.
    
    \example appWindow().getSimulationPanel()
    
Author:
Auto-generated
  • Method Details

    • setVisible

      void setVisible(boolean bVisible)
      Information provided by the PKI file:
      
          \brief Shows or hides this widget from view.
          
          \param bVisible, true to show this widget, false to hide it.
          
              
      Parameters:
      bVisible - Takes in a parameter of bVisible
    • setWidgetVisible

      void setWidgetVisible(String widgetName, boolean bVisible)
      Information provided by the PKI file:
      
          \brief Shows or hides the specified child widget.
          
          \param widgetName, where widgetName can be one of the following: ResetSimulationBtn, BackBtn, PlayBtn, ForwardBtn, EditFilterBtn, ShowAllBtn, ConstantDelayBtn.
          \param bVisible, true to show this child widget, false to hide it.
          
              
      Parameters:
      widgetName - Takes in a parameter of widgetName
      bVisible - Takes in a parameter of bVisible
    • setDisabled

      void setDisabled(boolean bDisable)
      Information provided by the PKI file:
      
          \brief Enables or disables input events to this widget.
          
          \param bDisabled, true to disable input events to this widget, false to enable input events.
          
              
      Parameters:
      bDisable - Takes in a parameter of bDisable
    • setWidgetDisable

      void setWidgetDisable(String widgetName, boolean bVisible)
      Information provided by the PKI file:
      
          \brief Enables or disables the specified child widget.
          
          \param widgetName, where widgetName can be one of the following: ResetSimulationBtn, BackBtn, PlayBtn, ForwardBtn, EditFilterBtn, ShowAllBtn, ConstantDelayBtn.
          \param bDisabled, true to disable input events to this child widget, false to enable input events.
          
              
      Parameters:
      widgetName - Takes in a parameter of widgetName
      bVisible - Takes in a parameter of bVisible
    • resetSimulation

      void resetSimulation()
      Information provided by the PKI file:
      
          \brief Simulates clicking on the Reset Simulation button.
          
              
    • play

      void play()
      Information provided by the PKI file:
      
          \brief Simulates clicking on the Auto Capture / Play button.
          
              
    • back

      void back()
      Information provided by the PKI file:
      
          \brief Simulates clicking on the Back button.
          
              
    • forward

      void forward()
      Information provided by the PKI file:
      
          \brief Simulates clicking on the Capture / Forward button.
          
              
    • isPlaying

      boolean isPlaying()
      Information provided by the PKI file:
      
          \brief Returns true if the simulation is currently playing, otherwise false.
          
          \return bool, true if the simulation is currently playing, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • populateEventList

      void populateEventList()
      Information provided by the PKI file:
      
          \brief Refreshes the display of the event list.
          
          \remark This function is generally not required unless there was direct manipulate of the events in the engine.
          
              
    • changePlaySpeed

      void changePlaySpeed(int value)
      Information provided by the PKI file:
      
          \brief Changes the play speed of the simulation.
          
          \param value, the value of the play speed.
          
              
      Parameters:
      value - Takes in a parameter of value
    • setFilter

      void setFilter(String protocol, boolean bSet)
      Information provided by the PKI file:
      
          \brief Enables or disables the specified event list filter.
          
          \param protocol, the name of the protocol.
          \param bSet, true to check the event list filter, false to uncheck it.
          
              
      Parameters:
      protocol - Takes in a parameter of protocol
      bSet - Takes in a parameter of bSet
    • setAllFilters

      void setAllFilters()
      Information provided by the PKI file:
      
          \brief Enables or disables all of the event list filters.
          
              
    • showFiltersDialog

      void showFiltersDialog()
      Information provided by the PKI file:
      
          \brief Simulates clicking on the Edit Filters button.
          
              
    • setConstantDelay

      void setConstantDelay(boolean bSet)
      Information provided by the PKI file:
      
          \brief Enables or disables constant delay.
          
          \param bSet, true to enable constant delay, false to disable it.
          
              
      Parameters:
      bSet - Takes in a parameter of bSet